home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / FIRE0597.ZIP / PYROVIEW.DOX < prev    next >
Text File  |  1996-05-09  |  13KB  |  258 lines
  1.  
  2. [insert fractal's pv ascii here]
  3.  
  4. ┌─────────────────────╖
  5. │ * Pyroview Features ║
  6. └═════════════════════╝
  7.  
  8.  Pyroview is a self-contained graphics viewer capable of displaying all
  9.  formats currently included in art packs. (well, maybe not *all* formats,
  10.  yet :) )
  11.  
  12.  Features:
  13.  
  14.  ■ Views ansi/ascii files in standard textmodes (80x25, 80x43, 80x50),
  15.    tweaked text modes (80x28, 80x30, 80x34, 80x60), and VESA textmodes
  16.    (132x25, 132x43, 132x50, 132x60). Viewing at higher resolutions is
  17.    also supported via the VGA 320x200, 320x400 modes, 360x240, and
  18.    360x480 modes and the VESA SVGA 640x400, 640x480, 800x600, 1024x768,
  19.    and 1280x1024 modes. Supports smooth and auto-scrolling. (Smooth
  20.    scrolling is currently only supported in 80x25 mode)
  21.  
  22.  ■ Views binary ansi files in standard textmodes (80x25, 80x43, 80x50),
  23.    tweaked text modes (80x28, 80x30, 80x34, 80x60), and VESA textmodes
  24.    (132x25, 132x43, 132x50, 132x60). Viewing at higher resolutions is
  25.    also supported via the VGA 320x200, 320x400 modes, 360x240, and
  26.    360x480 modes and the VESA SVGA 640x400, 640x480, 800x600, 1024x768,
  27.    and 1280x1024 modes. Supports smooth scrolling in all 4 directions.
  28.    (80x25 is the only supported mode in this beta version)
  29.  
  30.  ■ Views RIPscrip format files and incorporates Fire's new RIPscrip 1.62
  31.    specification, providing for fully animated RIPs. The entire set of
  32.    BGI stroked fonts is supported and included with Pyroview. Note: the
  33.    font files (*.chr) must be located in the same directory as the Pyroview
  34.    executable file, which is not neccessarily the current directory.
  35.  
  36.  ■ Displays JPEG, GIF, PCX, and BMP files, using standard VGA and VESA
  37.    SVGA modes, from 320x200 to 1280x1024 pixels, and from 8 to 24 bits
  38.    per pixel. The appropriate mode to use is automatically-detected.
  39.  
  40.  ■ Shows your mom.
  41.  
  42.  
  43. ┌──────────────────────────╖
  44. │ * Program Configuration  ║
  45. └══════════════════════════╝
  46.  
  47.  Pyroview can be configured to operate to your liking. Pressing the F10
  48.  function key while in the interface puts you in configuration mode. You
  49.  can also change most program options from the interface by pressing the
  50.  appropriate key (see the help screen (F1) for a list). Any changes you
  51.  make while in the interface or configuration mode will not be saved unless
  52.  you enter confugration mode and choose the "Save" command (Alt-S), which
  53.  saves all the options active at the time of the save so that you can use
  54.  those settings the next time you run Pyroview. All changes are written
  55.  directly to the executable, so there's no need to fool with an external
  56.  configuration file.
  57.  
  58.  Brief descriptions of the options available in configuration mode are
  59.  listed below:
  60.  
  61.  Resolution:  This option selects which video mode to view ansis and binary
  62.               ansis in. Not all video cards can handle all the modes listed.
  63.               Due to time constraints, I'm using only VESA modes in this
  64.               version, so your video card must support VESA BIOS extensions
  65.               in order to display ansis in VGA modes higher than 320x400.
  66.  
  67.  FontSize:    This option affects the aspect ratio of the displayed image;
  68.               ie., the width vs. the height. You are selecting actual video
  69.               modes to use when the previous option is set to "Textmode".
  70.               Otherwise, you are selecting the scaling ratios to use when
  71.               converting the textmode characters to the graphics mode pixels.
  72.               Note: The 132x??? textmodes are only available on VESA systems.
  73.               Like the previous option, this option only affects the viewing
  74.               of ansi and binary ansi files.
  75.  
  76.  Baudrate:    This option lets you simulate a modem connection to a remote
  77.               host, and is most often used to slow the speed at which files
  78.               are displayed. This option only affects the speed at which RIP
  79.               files are displayed, and the speed at which ansis are shown
  80.               while in Animation mode. It does not affect the viewing of
  81.               any file type while in View mode.
  82.  
  83.  Color mode:  Ansi  - Default. Colors will be displayed as stored in the
  84.                       graphics file.
  85.               Gray  - The palette will be reduced to 3 shades of gray.
  86.               Ascii - All color information will be stripped and replaced
  87.                       with standard DOS color 7 (dark white). Allows viewing
  88.                       of "invisible" greets.
  89.  
  90.  IceColor:    Default is on. When enabled, a full 16 colors can be used for
  91.               the background, as opposed to the standard 8 colors. Blinking
  92.               text is no longer possible while IceColor is enabled. Any text
  93.               that was blinking will be non-blinking, but on a high-color
  94.               background. Note: Why the hell do people call this IceColor?
  95.               Wintermute and Maxwell were using this well known part of the
  96.               video BIOS long before Ice, so we should call it FireColor :)
  97.  
  98.  Scrolling:  Smooth - Default. Scrolls by pixel. Some multitaskers won't
  99.                       like this very much.
  100.              Normal - Scrolls line by line.
  101.              Auto   - This toggle controls whether or not the ansi starts
  102.                       scrolling as soon as it is loaded, or whether the
  103.                       viewer should wait and let the user control the
  104.                       scrolling.
  105.  
  106.  
  107. ┌─────────────────────────╖
  108. │ * Command-Line Options  ║
  109. └═════════════════════════╝
  110.  
  111.  Like most dos utilities, Pyroview supports command-line parameters:
  112.  
  113.  Pyroview [/R:#] [/F:#] [/B:#] [/C:{N,G,A}[I]] [/S:[N|S][A]] [/V] [files]
  114.  
  115.  ┌─────────────────┐┌──────────────────┐┌───────────┐┌─────────────┐
  116.  │ Resolution (/R) ││ Font Size   (/F) ││ Baud (/B) ││ Colors (/C) │
  117.  ├─────────────────┤├───┬────────┬─────┤├───────────┤├─────────────┤
  118.  │ 0 │  Text Mode  ││   │  TEXT  │ VGA ││ 0 │ Off   ││ N │ Normal  │
  119.  │ 1*│  320 x 200  ││   ├────────┼─────┤│ 1 │ 300   ││ G │ Grey    │
  120.  │ 2*│  320 x 400  ││ 1 │  80x25 │ 1x2*││ 2 │ 1200  ││ A │ Ascii   │
  121.  │ 3*│  360 x 240  ││ 2 │  80x28 │ 1x4*││ 3 │ 2400  ││ I │ IceColor│
  122.  │ 4*│  360 x 480  ││ 3 │  80x43 │ 2x2*││ 4 │ 4800  │├─────────────┤
  123.  │ 5*│  640 x 400  ││ 4 │  80x50 │ 2x4*││ 5 │ 9600  ││ Scroll (/S) │
  124.  │ 6*│  640 x 480  ││ 5 │ 132x25 │ 2x8*││ 6 │ 14400 │├─────────────┤
  125.  │ 7*│  800 x 600  ││ 6 │ 132x43 │ 4x4*││ 7 │ 28800 ││ N │ Normal  │
  126.  │ 8*│ 1024 x 768  ││ 7 │ 132x50 │ 4x8*││ 8 │ 38400 ││ S │ Smooth  │
  127.  │ 9*│ 1280 x 1024 ││ 8 │ 132x60 │ 6x8*││ 9 │ 57600 ││ A │ Auto    │
  128.  └─────────────────┘└──────────────────┘└───────────┘└─────────────┘
  129.   * = unsupported :)
  130.  
  131.  The `files` parameter can be one of the following:
  132.  
  133.  mask(s)   - Up to 10 standard DOS filemasks, with wildcards, each
  134.              seperated by a space. These masks temporarily replace
  135.              the 10 masks specified in the config. Each mask can be
  136.              up to 12 characters in length, except the first mask,
  137.              which can contain up to 80 characters and can contain
  138.              directory information. If you specify a directory in the
  139.              first mask, that mask will be used in reading the files.
  140.              Otherwise, Pyroview will look in the current directoy for
  141.              files matching the masks. Interactive mode will be used by
  142.              default. To force Slide Show mode, include the `/V` parameter
  143.              on the command-line.
  144.  
  145.              Example:
  146.  
  147.              Pyroview  HAL*.ANS  GOD*.RIP  MAX*.EXE
  148.  
  149.  
  150.  @Filename - Text file containing list of files to view, one file per line.
  151.              You can give a full path to the list file if needed, or just
  152.              the file name if it's in the current directory. This option
  153.              turns Slide Show mode on. Files are viewed in the order they
  154.              appear in the file list. Wildcards are supported in the list.
  155.              Any lines preceeded by semicolons are considered comments and
  156.              will be ignored. When viewing files in Slide Show mode, all
  157.              files will be displayed consecutively unless the user aborts
  158.              with ESC. Pressing SPACE aborts the current file and proceeds
  159.              to the next file in the list. Press SPACE or ENTER to move to
  160.              the next file after a file has been shown, or press F1 for more
  161.              information. If you do not specify the full path to a file in
  162.              the list, Pyroview will check to see if you specified a direct-
  163.              ory to search in on the command-line, and if so, it will look
  164.              in that directory for the files. Otherwise, Pyroview will search
  165.              the current directory. Files in the list which contain path
  166.              information will be processed normally.
  167.  
  168.              Examples:
  169.  
  170.              Assume the file `fire0596.lst` contains the following lines:
  171.  
  172.              *.ANS
  173.              *.BIN
  174.              *.ASC
  175.              *.RIP
  176.              *.GIF
  177.              *.JPG
  178.              ; show my favorite ansis too
  179.              d:\art\ansi\cool\*.*
  180.  
  181.  
  182.              The following command will display all files in the current
  183.              directory matching the wildcards listed above, plus all files
  184.              in `d:\art\ansi\cool\`.
  185.  
  186.              Pyroview  @fire0596.lst
  187.  
  188.              The following command will display all files in the `c:\art`
  189.              directory matching the wildcards listed above, plus all files
  190.              in `d:\art\ansi\cool\`.
  191.  
  192.              Pyroview  @fire0596.lst  c:\art
  193.  
  194.  
  195. ┌─────────────────────╖
  196. │ * Bugs/Limitations  ║
  197. └═════════════════════╝
  198.  
  199.  Since this version of Pyroview was put together in less then 3 weeks,
  200.  I haven't had time to thouroughly test everything, there are bound to
  201.  be some nasty bugs. If you find anything wrong with pyroview, let me
  202.  know at spectre@expert.cc.purdue.edu and I'll see what I can do to help.
  203.  There are also quite a few limitations in this version which will be
  204.  eliminated in future versions (see below). These limitations include,
  205.  but are not limited to the following:
  206.    - Ansis will smooth scroll only in 80x25 mode, and you won't be able
  207.      to switch to another mode/font while in 80x25 smooth scrolling mode.
  208.      Change to 'normal' scrolling to use the vga modes or the extended
  209.      textmode fonts (the 132x?? fonts kick ass)
  210.    - VGA viewing of ansis doesn't exist yet. I was toying around with the
  211.      idea of using 64K color modes so I can represent the shading of the
  212.      ansi more accuately than is possible in the standard 256 color modes.
  213.      What do you think?
  214.    - .BIN's will be FUBAR if they're bigger than 64k or so. I'll fix it
  215.      later.
  216.    - There's no game in this version. Give me suggestions of which game
  217.      you'd like to see, like 80's arcade games.
  218.    - The Alt-E (editor) key from the Interface currently just runs the
  219.      DOS editor, but it'll be configurable later. If you really want to
  220.      run another editor, or include a file on the command line, simply
  221.      make a batch file called 'EDIT.BAT' and put in whichever directory
  222.      you'll be viewing files from. Whenever you hit Alt-E from the Inter-
  223.      face, whatever is in that batch file will be executed. This might
  224.      come in handy for various other utilities besides text editors. Maybe
  225.      you could put TheDraw in there... Thus will be configurable in the
  226.      future.
  227.    - It sucks, I'm tired, I'm bored, and I WANT MY INTERNET ACCOUNT BACK! :(
  228.  
  229.  
  230. ┌─────────────────────╖
  231. │ * Acknowledgements  ║
  232. └═════════════════════╝
  233.  
  234.  This version of Pyroview is dedicated to wintermute. and obscurity. and
  235.  crisis. and the immortal. and neurosis. and distortion. and my mom. and
  236.  your mom. and halaster's dad. 
  237.  
  238.  Pyroview was coded by maxwell, with help from Lord Cracker and Aphelion.
  239.  
  240.  Art by: Halaster, God Amoung Lice, and Squidulator2.
  241.  
  242.  I have learned from coding examples provided by other coders,
  243.  most notably Greater Evil (Relicvu), Mr. Kite (Shiver View),
  244.  and SiDS (ACiDViEW).
  245.  
  246.  Pyroview was written using Borland Turbo C++ 3.0, Borland C++ 4.5,
  247.  and Borland Turbo Assembler 4.0. Not bad for my first C program. :)
  248.  
  249.  The RIP 1.61 specification is by God Amoung Lice and Panacea.
  250.  The JPEG code is by the Independent JPEG Group.
  251.  "The Graphics Interchange Format(c) is the Copyright property of
  252.  CompuServe Incorporated.  GIF(sm) is a Service Mark property of
  253.  CompuServe Incorporated."
  254.  
  255.  
  256.  This document and Pyroview are Copyright (C) 1996 Clay McClure (maxwell).
  257.  (Well, not really, but you get the idea)
  258. SAUCE00Pyroview Documentation for v5.0    Maxwell             fire                19960508á1P